//
// (C) Copyright 2009 Irantha Suwandarathna (irantha@gmail.com)
// All rights reserved.
//

/* Copyright (c) 2001-2008, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use _in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions _in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer _in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


using System;
using System.Collections.Generic;
using System.Linq;
using EffiProz.Core.Lib;
using EffiProz.Core.Persist;


namespace EffiProz.Core
{

    /**
     * Manages rows involved _in transactions
     *
     * @author fredt@users
     * @version  1.8.0
     * @since 1.8.0
     */
    public interface TransactionManager
    {

         long getGlobalChangeTimestamp();

        RowAction addDeleteAction(Session session, Table table, Row row);

        void addInsertAction(Session session, Table table, Row row);

        /**
         * add session to the end of queue when a transaction starts
         * (depending on isolation mode)
         */
        void beginAction(Session session, Statement cs);

        void beginTransaction(Session session);

        // functional unit - accessibility of rows
        bool canRead(Session session, Row row);

        bool canRead(Session session, int id);

        bool commitTransaction(Session session);

        void completeActions(Session session);

        /**
         * Convert row ID's for cached table rows in transactions
         */
        void convertTransactionIDs(DoubleIntIndex lookup);

        /**
         * Return a lookup of all row ids for cached tables in transactions.
         * For auto-defrag, as currently there will be no RowAction entries
         * at the time of defrag.
         */
        DoubleIntIndex getTransactionIDList();

        int getTransactionControl();

        bool isDeleted(Session session, Row row);

        bool isMVRows();

        bool prepareCommitActions(Session session);

        void rollback(Session session);

        void rollbackAction(Session session);

        void rollbackSavepoint(Session session, int index);

        void setTransactionControl(Session session, int mode);

        /**
         * add transaction info to a row just loaded from the cache. called only
         * for CACHED tables
         */
        void setTransactionInfo(CachedObject _object);
    }
}
